﻿/* Copyright 2008 dnAnalytics Project.
 *
 * This file is part of dnAnalytics.  dnAnalytics is licensed under the 
 * Microsoft Public License. See License.txt for a complete copy of the
 * license.
 */

using System;
using System.Runtime.Serialization;

namespace dnAnalytics.LinearAlgebra
{
    ///<summary>The exception is thrown when a none positive definite matrix is passed a method not expecting one.</summary>
    [Serializable]
    public sealed class NotPositiveDefiniteException : MatrixException
    {
        ///<summary>Initializes a new instance of the <b>NotPositiveDefiniteException</b> class.</summary>
        public NotPositiveDefiniteException() {}

        ///<summary>Initializes a new instance of the <b>NotPositiveDefiniteException</b> class with a specified error message.</summary>
        ///<param name="message">The error message that explains the reason for the exception.</param>
        public NotPositiveDefiniteException(String message) : base(message) {}

        ///<summary>Initializes a new instance of the <b>NotPositiveDefiniteException</b> class with a specified error message 
        ///and a reference to the inner exception that is the cause of this exception.</summary>
        ///<param name="message">The error message that explains the reason for the exception.</param>
        ///<param name="inner">The exception that is the cause of the current exception. 
        ///If the innerException parameter is not a null reference, the current exception is raised in a <b>catch</b> block 
        ///that handles the inner exception.</param>
        public NotPositiveDefiniteException(String message, Exception inner) : base(message, inner) {}

        ///<summary>Initializes a new instance of the <b>NotPositiveDefiniteException</b> class with serialized data.</summary>
        ///<param name="info">The error message that explains the reason for the exception.</param>
        ///<param name="context">The error message that explains the reason for the exception.</param>
        private NotPositiveDefiniteException(SerializationInfo info, StreamingContext context) : base(info, context) {}
    }
}